home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audiofile / afGetLoopStartFrame.z / afGetLoopStartFrame
Encoding:
Text File  |  2002-10-03  |  7.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee((((3333ddddmmmm))))                              aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afGetLoopStartFrame, afGetLoopEndFrame, afGetLoopCount - get the
  10.      start/end frame and loop count from an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure for a
  11.      specified loop.
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  15.  
  16.      AAAAFFFFffffrrrraaaammmmeeeeccccoooouuuunnnntttt aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  17.                                         iiiinnnntttt llllooooooooppppiiiidddd))))
  18.      AAAAFFFFffffrrrraaaammmmeeeeccccoooouuuunnnntttt aaaaffffGGGGeeeettttLLLLooooooooppppEEEEnnnnddddFFFFrrrraaaammmmeeee((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  19.                                         iiiinnnntttt llllooooooooppppiiiidddd))))
  20.      iiiinnnntttt aaaaffffGGGGeeeettttLLLLooooooooppppCCCCoooouuuunnnntttt((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  21.                                         iiiinnnntttt llllooooooooppppiiiidddd))))
  22.  
  23. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  24.      _f_i_l_e     is an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure, previously created by a call to
  25.               aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm).
  26.  
  27.      _i_n_s_t_i_d   is a positive integer value which identifies an instrument
  28.               configuration in _f_i_l_e.  _i_n_s_t_i_d should be an element from an
  29.               array of IDs retrieved via a call to aaaaffffGGGGeeeettttIIIInnnnssssttttIIIIDDDDssss(3dm).
  30.  
  31.      _l_o_o_p_i_d   is a positive integer value which identifies a loop structure in
  32.               an instrument parameter chunk.  You obtain _l_o_o_p_i_d's by calling
  33.               aaaaffffGGGGeeeettttLLLLooooooooppppIIIIDDDDssss(3dm).
  34.  
  35. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  36.      aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee(((()))) returns a non-negative AFframecount type
  37.      representing the frame number for the loop start point, or -1 if there is
  38.      an error.
  39.  
  40.      aaaaffffGGGGeeeettttLLLLooooooooppppEEEEnnnnddddFFFFrrrraaaammmmeeee(((()))) returns a non-negative AFframecount type representing
  41.      the frame number for the loop end point, or -1 if there is an error.
  42.  
  43.      aaaaffffGGGGeeeettttLLLLooooooooppppCCCCoooouuuunnnntttt(((()))) returns a non-negative integer indicating the number of
  44.      times a loop should be repeated.  This information is only available
  45.      and/or storable in certain file formats (see WWWWAAAAVVVVEEEE(4)).  For all formats
  46.      which do not store this information, aaaaffffGGGGeeeettttLLLLooooooooppppEEEEnnnnddddFFFFrrrraaaammmmeeee(((()))) will return 0.
  47.  
  48. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  49.      Each takes a _l_o_o_p_i_d argument which provides a handle to a set of loop
  50.      parameters.
  51.  
  52.      You can obtain a list of loop ID's for an audio track by calling
  53.      aaaaffffGGGGeeeettttLLLLooooooooppppIIIIDDDDssss(3dm).  Logically, an audio file contains chunks of
  54.      instrument parameters (specified by _i_n_s_t_i_d handles), and each chunk of
  55.      instrument parameters may contain several loops.
  56.  
  57.      AAAAIIIIFFFFFFFF(4) (and AIFF-C) files contain at most one instrument configuration,
  58.      but other file formats may contain multiple configurations, so it is now
  59.      recommended that aaaaffffGGGGeeeettttIIIInnnnssssttttIIIIDDDDssss(3dm) be used to retrieve an array of IDs.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee((((3333ddddmmmm))))                              aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      aaaaffffQQQQuuuueeeerrrryyyy(3dm) may be used to determine in advance whether a particular
  75.      format supports multiple inst chunks.
  76.  
  77.      These routines allow you to obtain direct information about loops in an
  78.      audio file without the added overhead of looking up associated markers
  79.      (see aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt(3dm)).  This is necessary because several file
  80.      formats now supported by the Audio File Library contain loop information
  81.      (i.e., start and end points) which is completely independent of marker
  82.      information.  In other words, the markers (if any) stored in the file
  83.      header may and usually will refer to locations in the file other than the
  84.      loop start and end points.
  85.  
  86. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  87.      aaaaffffGGGGeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee(((()))) returns the value 125000.  This is the frame number
  88.      in the audio track for the beginning of the specified loop.
  89.  
  90. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  91.      These functions may return any configurations of loops within an inst,
  92.      not just the value 2 found in AIFF/AIFF-C files.  Other file formats have
  93.      different loop configurations than AIFF/AIFF-C.  As mentioned above,
  94.      aaaaffffQQQQuuuueeeerrrryyyy(3dm) can be used to determine the possible loop configurations
  95.      for a given file format.  Programs should be written to expect and ignore
  96.      loop configurations it does not understand.
  97.  
  98. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  99.      afOpenFile(3dm), afGetInstIDs(3dm), afGetInstParamLong(3dm),
  100.      afGetLoopIDs(3dm), afGetLoopStart(3dm), aiff(4), avr(4), wave(4), sd2(4)
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.